Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added osName to 2022-05-10-preview #19970

Merged
merged 1 commit into from
Jul 28, 2022
Merged

Added osName to 2022-05-10-preview #19970

merged 1 commit into from
Jul 28, 2022

Conversation

justinytchen
Copy link
Member

@justinytchen justinytchen commented Jul 26, 2022 •
edited
Loading

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?

    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
      The spec for 2022-05-10-preview was unintentionally changed and the osName property was removed accidentally causing a Sev 2. This PR addresses that.

  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
    As soon as possible

  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    As soon as possible

  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.

    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @justinytchen Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 26, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    HybridCompute.json 2022-05-10-preview(68ae29b) 2022-05-10-preview(main)
    Rule Message
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'osName' that was not found in the old version.
    New: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L977:7
    Old: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L977:7
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-preview-2022-05 package-preview-2022-05(68ae29b) package-preview-2022-05(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1143
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1177
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1225
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1245
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'extensions' with immediate parent 'Machine', must have a list by immediate parent operation.
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1222
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L746
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutomaticUpgrade
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1276
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1280
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutomaticUpgrade
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1325
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1329
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Machines by resource group
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L318
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or Update a Machine Extension
    Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L450
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 4 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/68ae29be6cf760bfce8f805b1d7ba731c478f286/specification/hybridcompute/resource-manager/readme.md#tag-package-preview-2022-05">hybridcompute/resource-manager/readme.md#package-preview-2022-05
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ Modeler/MissingType "readme":"hybridcompute/resource-manager/readme.md",
    "tag":"package-preview-2022-05",
    "details":"The schema 'components·1pl4ixg·schemas·machineextensionproperties·properties·settings·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#/components/schemas/components·1pl4ixg·schemas·machineextensionproperties·properties·settings·additionalproperties"
    ⚠️ Modeler/MissingType "readme":"hybridcompute/resource-manager/readme.md",
    "tag":"package-preview-2022-05",
    "details":"The schema 'components·18d558g·schemas·machineextensionproperties·properties·protectedsettings·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#/components/schemas/components·18d558g·schemas·machineextensionproperties·properties·protectedsettings·additionalproperties"
    ⚠️ Modeler/MissingType "readme":"hybridcompute/resource-manager/readme.md",
    "tag":"package-preview-2022-05",
    "details":"The schema 'components·f9j7vk·schemas·machineextensionupdateproperties·properties·settings·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#/components/schemas/components·f9j7vk·schemas·machineextensionupdateproperties·properties·settings·additionalproperties"
    ⚠️ Modeler/MissingType "readme":"hybridcompute/resource-manager/readme.md",
    "tag":"package-preview-2022-05",
    "details":"The schema 'components·1a7hg8v·schemas·machineextensionupdateproperties·properties·protectedsettings·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#/components/schemas/components·1a7hg8v·schemas·machineextensionupdateproperties·properties·protectedsettings·additionalproperties"


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"hybridcompute/resource-manager/readme.md",
    "tag":"package-preview-2022-05",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 26, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ❌azure-sdk-for-go - armhybridcompute - 2.0.0-beta.1
    -	Field `OSName` of struct `MachineProperties` has been removed
    ❌azure-sdk-for-python-track2 - track2_azure-mgmt-hybridcompute - 7.0.0
    -	Model MachineProperties no longer has parameter os_name
    ❌azure-sdk-for-js - @azure/arm-hybridcompute - 4.0.0-beta.1
    -	Interface MachineProperties no longer has parameter osName
    ️❌ azure-sdk-for-net failed [Detail]
    • ❌Failed [Logs]Release - Generate from 7b68a8c. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/hybridcompute/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7b68a8c. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-hybridcompute [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group HybridComputeManagementClientOperationsMixin
info	[Changelog]   - Model HybridComputePrivateLinkScopeProperties has a new parameter private_endpoint_connections
info	[Changelog]   - Model Machine has a new parameter resources
info	[Changelog]   - Model MachineExtensionProperties has a new parameter enable_automatic_upgrade
info	[Changelog]   - Model MachineExtensionUpdateProperties has a new parameter enable_automatic_upgrade
info	[Changelog]   - Model MachineProperties has a new parameter agent_configuration
info	[Changelog]   - Model MachineProperties has a new parameter cloud_metadata
info	[Changelog]   - Model MachineProperties has a new parameter mssql_discovered
info	[Changelog]   - Model MachineProperties has a new parameter os_type
info	[Changelog]   - Model MachineProperties has a new parameter service_statuses
info	[Changelog]   - Model MachineUpdateProperties has a new parameter cloud_metadata
info	[Changelog]   - Model MachineUpdateProperties has a new parameter os_profile
info	[Changelog]   - Model OSProfile has a new parameter linux_configuration
info	[Changelog]   - Model OSProfile has a new parameter windows_configuration
info	[Changelog]   - Model OperationValue has a new parameter is_data_action
info	[Changelog]   - Model PrivateEndpointConnectionProperties has a new parameter group_ids
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model MachineProperties no longer has parameter extensions
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7b68a8c. SDK Automation 14.0.0 
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armhybridcompute [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `MachineExtensionProperties.ProtectedSettings` has been changed from `interface{}` to `map[string]interface{}`
info	[Changelog] - Type of `MachineExtensionProperties.Settings` has been changed from `interface{}` to `map[string]interface{}`
info	[Changelog] - Type of `MachineExtensionUpdateProperties.ProtectedSettings` has been changed from `interface{}` to `map[string]interface{}`
info	[Changelog] - Type of `MachineExtensionUpdateProperties.Settings` has been changed from `interface{}` to `map[string]interface{}`
info	[Changelog] - Field `Extensions` of struct `MachineProperties` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `AgentConfigurationModeMonitor`
info	[Changelog] - New const `AgentConfigurationModeFull`
info	[Changelog] - New function `PossibleAgentConfigurationModeValues() []AgentConfigurationMode`
info	[Changelog] - New field `Resources` in struct `Machine`
info	[Changelog] - New field `ConfigMode` in struct `AgentConfiguration`
info	[Changelog] - New field `EnableAutomaticUpgrade` in struct `MachineExtensionUpdateProperties`
info	[Changelog]
info	[Changelog] Total 3 breaking change(s), 6 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7b68a8c. SDK Automation 14.0.0 
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-hybridcompute [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface AgentConfiguration
info	[Changelog]   - Added Interface CloudMetadata
info	[Changelog]   - Added Interface ConfigurationExtension
info	[Changelog]   - Added Interface OSProfileLinuxConfiguration
info	[Changelog]   - Added Interface OSProfileWindowsConfiguration
info	[Changelog]   - Added Interface PrivateEndpointConnectionDataModel
info	[Changelog]   - Added Interface ServiceStatus
info	[Changelog]   - Added Interface ServiceStatuses
info	[Changelog]   - Added Type Alias AgentConfigurationMode
info	[Changelog]   - Added Type Alias AssessmentModeTypes
info	[Changelog]   - Added Type Alias PatchModeTypes
info	[Changelog]   - Interface HybridComputePrivateLinkScopeProperties has a new optional parameter privateEndpointConnections
info	[Changelog]   - Interface MachineExtensionProperties has a new optional parameter enableAutomaticUpgrade
info	[Changelog]   - Interface MachineExtensionUpdateProperties has a new optional parameter enableAutomaticUpgrade
info	[Changelog]   - Interface MachineProperties has a new optional parameter agentConfiguration
info	[Changelog]   - Interface MachineProperties has a new optional parameter cloudMetadata
info	[Changelog]   - Interface MachineProperties has a new optional parameter mssqlDiscovered
info	[Changelog]   - Interface MachineProperties has a new optional parameter osType
info	[Changelog]   - Interface MachineProperties has a new optional parameter serviceStatuses
info	[Changelog]   - Interface MachineUpdateProperties has a new optional parameter cloudMetadata
info	[Changelog]   - Interface MachineUpdateProperties has a new optional parameter osProfile
info	[Changelog]   - Interface OperationValue has a new optional parameter isDataAction
info	[Changelog]   - Interface OSProfile has a new optional parameter linuxConfiguration
info	[Changelog]   - Interface OSProfile has a new optional parameter windowsConfiguration
info	[Changelog]   - Interface PrivateEndpointConnectionProperties has a new optional parameter groupIds
info	[Changelog]   - Type Alias Machine has a new parameter resources
info	[Changelog]   - Added Enum KnownAgentConfigurationMode
info	[Changelog]   - Added Enum KnownAssessmentModeTypes
info	[Changelog]   - Added Enum KnownPatchModeTypes
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface MachineProperties no longer has parameter extensions
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7b68a8c. Schema Automation 14.0.0 
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️hybridcompute [View full logs]  [Release Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7b68a8c. SDK Automation 14.0.0 
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.HybridCompute [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @azure-sdk azure-sdk mentioned this pull request Jul 26, 2022
    Closed
    This was referenced Jul 26, 2022
    Closed
    Closed
    This was referenced Jul 26, 2022
    Closed
    Closed
    Closed
    @dorothyhu
    Copy link
    Contributor

    Hi @live1206, we removed the osName field previously in this API version. It turned out that our partner teams and customers are automatically using our newest API because they don't have the control to API versions in the system they use. And this change broke their stuff. We would like to recall this change.

    @live1206
    Copy link
    Member

    live1206 commented Jul 28, 2022 •
    edited
    Loading

    Hi @live1206, we removed the osName field previously in this API version. It turned out that our partner teams and customers are automatically using our newest API because they don't have the control to API versions in the system they use. And this change broke their stuff. We would like to recall this change.

    To resolve the sev2 ICM sooner, I just approved this breaking change and merge the PR.
    @dorothyhu @justinytchen
    Could you paste the link of the previous change PR? We would like to see if we can avoid this breaking change happen again.

    @live1206 live1206 added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 28, 2022
    @live1206 live1206 merged commit 7b68a8c into Azure:main Jul 28, 2022
    This was referenced Jul 28, 2022
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @jianyunt jianyunt jianyunt approved these changes

    @live1206 live1206 live1206 approved these changes

    Assignees

    @live1206 live1206

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go CI-BreakingChange-JavaScript
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @justinytchen @dorothyhu @live1206 @jianyunt